docs: add module docstrings and improve method docstrings in profiles package#292
Merged
docs: add module docstrings and improve method docstrings in profiles package#292
Conversation
… package - Add module-level docstrings to geometry_profiles, light/abstract, light/standard/sersic, light/linear/abstract, light/operated/abstract, mass/abstract/abstract, and basis explaining what each module contains - Add class docstring to LightProfileOperated explaining the operated-only filtering pattern used throughout the codebase - Add docstrings to abstract MassProfile methods (deflections_yx_2d_from, convergence_2d_from, potential_2d_from, convergence_func, potential_func, mass_integral, ellipticity_rescale) including the lensing physics context - Add deflections_2d_via_potential_2d_from docstring explaining the finite-difference fallback implementation - Improve GeometryProfile.has() docstring with Parameters/Returns sections - Add docstrings to GeometryProfile abstract transform methods - Add docstrings to LightProfile.coefficient_tag, half_light_radius, _intensity Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
geometry_profiles,light/abstract,light/standard/sersic,light/linear/abstract,light/operated/abstract,mass/abstract/abstract, andbasismodulesLightProfileOperatedexplaining the operated-only filtering patternMassProfilemethods (deflections_yx_2d_from,convergence_2d_from,potential_2d_from,convergence_func,potential_func,mass_integral,ellipticity_rescale) including lensing physics contextdeflections_2d_via_potential_2d_fromexplaining the finite-difference fallbackGeometryProfile.has(),LightProfile.coefficient_tag,half_light_radius,_intensitydocstringsTest plan
🤖 Generated with Claude Code